
//
// Copyright (c) 2008, the /*jupiter jazz*/ group
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the /*jupiter jazz*/ group nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY the /*jupiter jazz*/ group ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL the /*jupiter jazz*/ group BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//

#ifndef CLASSLIB_PROGRESSIVEEXRIMAGEFILEREADER_H
#define CLASSLIB_PROGRESSIVEEXRIMAGEFILEREADER_H

// classlib headers.
#include "classlib/canvasproperties.h"
#include "classlib/exception.h"
#include "classlib/iprogressiveimagefilereader.h"

// Standard headers.
#include <cstddef>

// Forward declarations.
namespace foundation    { class CanvasProperties; }
namespace foundation    { class ICanvas; }
namespace foundation    { class ImageAttributes; }
namespace foundation    { class Tile; }
namespace Imf           { struct Channel; }

namespace foundation
{

//
// Progressive OpenEXR image file reader interface.
//

class ProgressiveEXRImageFileReader
  : public IProgressiveImageFileReader
{
  public:
    // Unsupported image format.
    struct ExceptionUnsupportedImageFormat : public Exception {};

    // Constructors.
    ProgressiveEXRImageFileReader();
    ProgressiveEXRImageFileReader(
        const size_t        default_tile_width,
        const size_t        default_tile_height);

    // Destructor.
    ~ProgressiveEXRImageFileReader();

    // Open an OpenEXR image file.
    virtual void open(
        const char*         filename);

    // Close the image file.
    virtual void close();

    // Return true if an image file is currently open.
    virtual bool is_open() const;

    // Read canvas properties.
    virtual void read_canvas_properties(
        CanvasProperties&   props);

    // Read an image tile. Returns a newly allocated tile.
    virtual Tile* read_tile(
        const size_t        tile_x,
        const size_t        tile_y);
        
  private:
    // Private implementation.
    struct Impl;
    Impl* impl;
};

}       // namespace foundation

#endif  // !CLASSLIB_PROGRESSIVEEXRIMAGEFILEREADER_H
